﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<link rel="Stylesheet" type="text/css" media="screen" href="Screen.css" />
  <title>StpCallback_FlushFdb</title>
</head>
<body>
	<h3>StpCallback_FlushFdb</h3>
	<hr />
<pre>
void StpCallback_FlushFdb
(
    BRIDGE* bridge,
    int     portIndex,
    int     treeIndex
);
</pre>
	<h4>
		Summary</h4>
	<p>Application-defined function that flushes FDB entries (MAC-to-port associations)
		on a physical port.
		</p>
	<p>
		<code>StpCallback_FlushFdb</code> is a placeholder name used throughout this documentation. The 
		application may name this callback differently.</p>
	<h4>
		Parameters</h4>
	<dl>
		<dt>bridge</dt>
		<dd>The application receives in this parameter a pointer to the bridge object returned by
			<a href="STP_CreateBridge.html">STP_CreateBridge</a>.</dd>
		<dt>portIndex</dt>
		<dd>The application receives in this parameter the index of the port on which FDB entries are to be flushed.</dd>
		<dt>treeIndex</dt>
		<dd>The application receives in this parameter the index of the MSTP spanning tree for which FDB entries are to be flushed. Since the STP
			library currently supports only one spanning tree (the CIST tree), all entries must be flushed.
		</dd>
	</dl>
	<h4>
		Remarks</h4>
		<p>
			Flushing of the FDB entries is usually realized by writing to the internal registers of 
			the bridge IC.</p>
	<p>
		This function must wait until the hardware has finished flushing the entries (i.e., it 
		must not just initiate flushing and return).
		</p>
	
</body>
</html>
